|
Other Identifiers
Combines all of the specified parameters, the same as using $+ in between each item.
Prompts the user for input and returns the result.
//echo $?="What is your name?"
If the user enters their name in the editbox and presses the OK button, $? will return whatever the user entered. If the user clicks on the Cancel button, $? returns nothing.
//echo $?*="What is your password?"
In this case the $?* makes any text that the user types into the editbox appear as ***** characters to prevent anyone seeing what is being entered.
//echo $?!="Shall I continue?"
In this case, a Yes/No dialog pops up. If the user clicks on Yes, $true is returned, otherwise $false is returned.
The input dialog is extended vertically to display the whole message if it is very long. You can also make text appear on different lines by using the $crlf identifier to separate the lines, eg.
//echo $?="This is on the first line. $crlf $+ And this is on the 2nd line."
Note: This identifier cannot be used in a script event. One way around this is to use a /timer to initiate an input request after the script ends.
Returns text with the ANSI codes converted into mIRC color codes.
Returns the value $true or $false depending on whether you are marked as away or not.
You can also use $awaymsg and $awaytime to return your current away settings.
Returns the clipboard contents.
$cb(N,u) Returns $crlf delimited lines from text currently in the clipboard.
Properties: len
$cb(0) returns the number of lines in the clipboard $cb(0).len return the total length of all lines in the clipboard $cb(1) returns line 1 from the clipboard $cb(1).len returns the length of line 1
Note: The u option indicates that utf8 text should be returned.
mIRC supports numeric 005 token CHANTYPES, and can handle a dynamic set of channel prefixes.
$chantypes returns the list of channel prefixes which can be joined, eg. #mIRC, &mIRC.
When not connected to a server, mIRC uses a default $chantypes value of CHANTYPES=#&.
mIRC supports numeric 005 token CHANMODES, and can handle a dynamic set of channel modes.
$chanmodes returns the list of supported channel modes, eg. '+k moo' to set the channel key to 'moo'.
When not connected to a server, mIRC uses a default $chanmodes value of CHANMODES=bIe,k,l.
Returns $true if a command or script was initiated via the command editbox in a channel window.
Returns the command line that was passed to mIRC when it was first run.
Returns the Nth color index of the specified color name eg. $color(action text). If you don't specify the full name the first partial match is returned eg. $color(action)
If you specify an N value, returns the RGB value for the Nth color box.
Properties: dd
$color(action).dd returns number in double-digit format
Returns the carriage return character, the same as $chr(13).
Returns current /creq settings in the DCC Options chat section dialog.
Returns a carriagereturn/linefeed combination.
Returns $true if ignore types is turned on in the DCC Folders dialog, otherwise returns $false.
$dccignore(N/filename) Returns the Nth item in the dcc ignore types editbox in the DCC Folders dialog.
If n is zero, returns number of items in list, otherwise returns Nth item in list. If a filename is specified, returns $true if it matches item in list, otherwise $false.
Returns the port being used by the DCC Server.
Returns the value resulting from a call to a DLL designed to work with mIRC.
Returns $true if sounds are enabled in the Sounds dialog.
Returns the text in the editbox of the specified window. If N = 1, returns the text in the second editbox in a channel window, if it's open.
Properties: selstart, selend
Returns the email address specified in the Connect dialog.
Evaluates the contents of text N times. If N isn't specified, the default is N = 1. If N is zero, text is not evaluated.
This allows you to recursively evaluate identifiers and variables in a line of text.
Returns the full name specified in the Connect dialog.
Returns a hash number based on text where B is the number of bits to use when calculating the hash number.
Returns $true if highlighting is turned on in the Highlight dialog, otherwise returns $false.
$highlight(N/text) Returns the Nth line in the highlight listbox, or if text is specified, returns the properties for the highlight line that matches text.
Properties: text, color, sound, flash, message, nicks, regex, cs
Returns your Local host name.
Returns T or F depending on whether the evaluation of the Conditional C is true or false.
$iif(1 == 2, yes, no) returns "no"
$iif() returns F if the conditional returns zero, $false, or $null. For any other value $iif() returns T.
If you don't specify the F parameter, $iif returns a T value if the condition is true, and returns nothing if it's false.
$iif(1 == 2, yes) returns nothing
You can find out more about conditionals in the if-then-else section.
Returns the first parameter of matching if-then-else comparison.
In the case of this comparison:
if (text isin sometext) { ... }
$ifmatch returns "text"
Returns the Nth address in the ignore list.
Properties: type, secs
$ignore(0) returns the total number of addresses in the ignore list $ignore(1) returns the 1st address in the ignore list $ignore(2).type returns the ignore flags for the 2nd address in the ignore list $ignore(2).secs returns number of seconds until ignore is removed if /ignore -uN was used
Note: If you specify an address, the first matching address in the ignore list is returned.
Returns $true if a user typed Control+V or Shift+Insert to paste text into an editbox, mainly useful when processing an on INPUT event.
$input(prompt,options,window,title,text) Prompts the user for input and returns the result.
The input dialog is extended vertically to display the prompt message if it is very long. You can also make text in the prompt message appear on different lines by using the $crlf identifier to separate lines.
Options can be a combination of the following:
e - show input editbox p - show input password editbox o - ok button y - yes no buttons n - yes no cancel buttons r - retry cancel buttons v - return $ok, $yes, $no, $cancel for buttons. g - right-align buttons
By default, buttons return $true or $null, same as $?. If there is an input editbox, the ok/yes buttons always return the contents of the editbox.
iqwh - show the info, question, warning, and hand icons respectively. d - play system sound associated with icon.
s - indicates that window name has been specified a - activate dialog u - use current active window as parent window
kN - an N second timeout value. On timing out, $timeout is returned if 'v' is specified, no value if 'e' is specified, and $false otherwise.
m - indicates that multiple text parameters have been specified. They will be displayed in a combobox. The first text item is the default item (a reference to an item in the list), the rest are the items in the list.
window - name of the window to be used as parent window.
title - the titlebar text.
text - the default text placed in the input editbox.
The options, window, title, and text are optional parameters.
Note: This identifier cannot be used in a script event. One way around this is to use a /timer to initiate an input request after the script ends.
Returns your IP address.
Returns $true if the specified name is an alias command that exists in your aliases or scripts.
Properties: fname, alias
$isalias(join) returns $true if you have an alias for /join $isalias(join).fname returns the filename in which the alias exists $isalias(join).alias returns the alias definition for /join
Returns $true if an alias was called as an identifier, otherwise $false.
Returns the linefeed character, the same as $chr(10).
Returns $true or $false for the lock settings on items in the Lock dialog.
Properties: send, get, chat, query, fserve, channels, com, decode, dll, run
You can also use $lock(N) where N returns the Nth channel in the limit channels listbox, or you can specify a channel name instead of N.
Returns $true if mIRC is currently locked.
$md5(text|&binvar|filename,[N]) Returns md5 hash value for the specified data, where N = 0 for plain text (default), 1 for &binvar, 2 for filename.
mIRC supports numeric 005 token MODES.
$modespl returns the maximum number of parameters allowed per /mode, eg. if $modespl is equal to 5, you can use /mode +ooooo to set five modes at a time.
Returns the name of the IRC network you are currently connected to.
Note: It may not be possible to get this info if a network doesn't provide it.
Returns the version number of the operating system. The reply can be 95, 98, NT, ME, 2K, XP, 2003, or Vista.
Returns $true if passive dcc is enabled in the DCC Options dialog.
Returns the port number of the server to which you're currently connected.
Returns $true or $false depending on whether mIRC was run as portable.
mIRC supports numeric 005 token PREFIX, and can handle a dynamic set of channel nickname prefixes.
$prefix returns the list of channel nickname prefixes ie. op, halfop, voice, etc. that are supported on a server.
When not connected to a server, mIRC uses a default $prefix value of PREFIX=(ohv)@%+.
Stores the number value returned to a calling routine by the /return command.
Returns RGB value of specified system color name which can be one of the following: face, shadow, hilight, 3dlight, frame, and text.
Returns the name of the server to which you are currently connected.
If you're not currently connected to a server, it returns $null.
$server(N/address) Returns the address of the Nth server in your irc servers list.
Properties: desc, port, group, pass
$server(0) returns the total number of servers in the servers list $server(2) returns the address of the 2nd server $server(2).desc returns the description of the 2nd server $server(3).port returns the port(s) of the 3rd server
If you specify an irc server address and it is in your servers list, it returns its associated info.
Returns server IP address.
$sha1(text|&binvar|filename,[N]) Returns sha1 hash value for the specified data, where N = 0 for plain text (default), 1 for &binvar, 2 for filename.
Returns $false if a command is prefixed with a . to make it quiet, otherwise returns $true.
Returns current /sreq settings in the DCC Options send section dialog.
Returns server connection status.
Note: This returns closing during the on DISCONNECT event if the status window being closed is the cause of the disconnection.
Returns the text in the mIRC titlebar, set by the /titlebar command.
Returns the currently active URL in your Web Browser.
$url(N) Returns the Nth address in your URL list.
Properties: desc, group
$url(0) returns the total number of items in the URL list $url(2) returns the address of the 2nd item in the list $url(2).desc returns the description of the 2nd item in the list $url(3).group returns the group of the 3rd item in the list
Returns your current usermode on the irc server.
Returns the version of mIRC that is being used. |